State 狀態模式

需求描述

Amy(PO):

As a 提需求單的使用者
I want 需求單管理系統支援在某個需求的狀態改變時，記錄時間並以Email通知同仁
So that 任何人可以輕易的識別目前需求的狀態

思考設計

JB:
我想可以透過一個switch來判斷某個需求目前的狀態，然後執行對應的作業。

Hachi:
恩，不過依照我們在Day5.Chain of Responsibility 職責鍊模式的經驗，用switch可能不是個好主意。
我們需要設定一個可以在每個狀態流動的模型，然後依照每個狀態去執行對應的動作。

Lily:
我們可以使用狀態模式(State)來實作這個需求，避免多重判斷和作業的程式碼。

JB::
聽起來不錯! 不過職責鍊也可以解決這個問題吧...!? 他們有何不同呢？

Lily:
我們先用狀態模式實作這個需求，然後我們再討論這兩種模式的使用時機。

定義

實作每個狀態的對應類別，當對象的狀態改變時，透過這些狀態類別定義的方法來執行對應的策略。(WIKI)

實作狀態模式的方式：

1. 建立每一種狀態的類別，它們定義了該狀態下要做那些事，以及決定下一個狀態。
2. 建立存放狀態的對象(Context)，它具有改變狀態的權力。

State

我們假設需求管理系統裡面的一項需求，具有以下四種狀態：

1. TODO
2. Working
3. Testing
4. Done

• C#

public abstract class State
{
    public abstract void Action(Context context);
}

//TODO
public class StateToDo : State
{
    public override void Action(Context context)
    {
        //Do something

        //Set next state
        context.CurrentState = new StateWorking();
        Trace.WriteLine("The requirement is on TODO list, send email to IT manager.");
    }
}

///Working
public class StateWorking : State
{
    public override void Action(Context context)
    {
        //Do something

        //Set next state
        context.CurrentState = new StateTesting();
        Trace.WriteLine("The requirement is completed, send email to users!");
    }
}

///Testing
public class StateTesting : State
{
    public override void Action(Context context)
    {
        //Do something

        //Set next state
        context.CurrentState = new StateDone();
        Trace.WriteLine("Test ok, send email to operation team!");
    }
}

///Done
public class StateDone : State
{
    public override void Action(Context context)
    {
        //Do something
        
        //No next state
        context.CurrentState = null;
        Trace.WriteLine("Close the requirement, send email to all stakeholders!");
    }
}

• Python

from abc import ABC, abstractmethod
import Context

class State(ABC):
    @abstractmethod
    def action(self,context=Context):
        pass

class StateToDo(State):
    def action(self,context=Context):
        
        # Do something...

        # Set next state
        context.currentState = StateWorking()
        print("The requirement is on TODO list, send email to IT manager.");

class StateWorking(State):
    def action(self,context=Context):
        
        # Do something...

        # Set next state
        context.currentState = StateTesting()
        print("The requirement is completed, send email to users!");


class StateTesting(State):
    def action(self,context=Context):
        
        # Do something...

        # Set next state
        context.currentState = StateDone()
        print("Test ok, send email to operation team!");
    
class StateDone(State):
    def action(self,context=Context):
        
        # Do something...

        # Set next state
        context.currentState = None
        print("Close the requirement, send email to all stakeholders!");

Context

由State的程式碼，我們得知在每一次Context開始作業(Action())時，必須把它自己作為參數丟給當下狀態對應的State類別，再由State類別去做事以及更新Context最新的狀態。

• C#

public class Context
{
    private State _state { get; set; }
    public State CurrentState
    {
        get { return this._state; }
        set { this._state = value; }
    }

    public Context()
    {
        //Set default state
        this._state = new StateToDo();
    }

    public void Action()
    {
        this._state.Action(this);
    }
}

• Python

class Context:
    
    def __init__(self):
        self.currentState = States.StateToDo()

    def action(self):
        self.currentState.action(self)

我們來看一個State的展示範例，我們用迴圈一次執行所有狀態的轉換：

• C#

var context = new Context();
while (context.CurrentState!=null)
{
    context.Action();
}

• Python

context = Context.Context()
while (context.currentState != None):
    context.action()

執行結果：
The requirement is on TODO list, send email to IT manager.
The requirement is completed, send email to users!
Test ok, send email to operation team!
Close the requirement, send email to all stakeholders!

假設在使用者測試(Testing)時發現Defect，必須回到上一狀態(Working)讓開發團隊處理。
我們可以額外定義一個ActionBack()方法來回到上一個狀態：

• C#

public abstract class State
{
    public abstract void Action(Context context);
    public abstract void ActionBack(Context context);
    
}

///僅列出測試狀態的類別: 加入ActionBack方法
public class StateTesting : State
{
    //Skip...

    public override void ActionBack(Context context)
    {
        //Do something

        //Set next state
        context.CurrentState = new StateWorking();
        Trace.WriteLine("Test NG, send email to development team!");
    }
}

///Context: 加入ActionBack方法
public class Context
{
    //Skip...

    public void ActionBack()
    {
        this._state.ActionBack(this);
    }

}

///主程式(回到上一個狀態)
if (hasDefect)
{
    context.ActionBack();
}

• Python

class State(ABC):
    @abstractmethod
    def action(self,context=Context):
        pass

    @abstractmethod
    def actionBack(self,context=Context):
        pass

"""僅列出測試狀態的類別: 加入ActionBack方法"""
class StateTesting(State):
    def __str__(self):
        return "Testing(測試中)"

    def action(self,context=Context):
        
        # Do something...

        # Set next state
        context.currentState = StateDone()
        print("Test ok, send email to operation team!");
    
    def actionBack(self,context=Context):
        
        # Do something...

        # Set next state
        context.currentState = StateWorking()
        print("Test NG, send email to development team!");

"""Context: 加入ActionBack方法"""
class Context:
    
    def __init__(self):
        self.currentState = States.StateToDo()

    def action(self):
        self.currentState.action(self)

    def actionBack(self):
        self.currentState.actionBack(self)
                
"""主程式(回到上一個狀態)"""
if(hasDefect):
    context.actionBack()

執行結果：
The requirement is on TODO list, send email to IT manager.
The requirement is completed, send email to users!
Test NG, send email to development team! => 測試失敗，回到上一個狀態!
The requirement is completed, send email to users!
Test ok, send email to operation team!
Close the requirement, send email to all stakeholders!

State vs Chain of Responsibility

狀態模式和職責鏈模式都可以解決有順序、多重判斷=>執行邏輯的問題，例如IF ELSE，SWITCH CASE。
但兩者運作的方式不同：

• State(狀態模式)

  1. 由對象(Context)控制何時轉換狀態及執行該狀態下的工作。
  2. 對像透過已定義好的順序，往前或往後轉換狀態。

• Chain of Responsibility(職責鏈模式)

  1. 對象只能決定何時發起鏈上的第一個點(Handler)，鏈上其他的點接續完成作業。
  2. 對像能在開始作業前，改變職責鏈的順序。

Sample Codes

1. C#

• Source code
• Unit Test

2. Python

• Source code
• Unit Test